feat(elk-stack-setup): add logging.file.name ci env #139
Conversation
WalkthroughThe changes introduce a new logging configuration entry in the Changes
Possibly related PRs
Poem
Warning Rate limit exceeded@ivor11 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 55 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
src/main/environment/common_ci.properties (2)
139-140: LGTM! Consider adding documentation.The configuration follows the established pattern and integrates well with the existing properties. However, consider adding a comment to document:
- Expected format/path constraints for the log file name
- Default value behavior if the environment variable is not set
#ELK logging file name +# Format: Absolute or relative path (e.g., /var/log/app.log or logs/app.log) +# Default: If not set, logs to console logging.file.name=@env.COMMON_API_LOGGING_FILE_NAME@
139-140: Consider adding complementary logging configurations.To ensure comprehensive logging setup, consider adding these common Spring Boot logging configurations:
#ELK logging file name logging.file.name=@env.COMMON_API_LOGGING_FILE_NAME@ + +# Log file rotation +logging.logback.rollingpolicy.max-file-size=@env.COMMON_API_LOG_MAX_SIZE@ +logging.logback.rollingpolicy.max-history=@env.COMMON_API_LOG_MAX_HISTORY@ + +# Log directory path (optional, if different from logging.file.name) +logging.file.path=@env.COMMON_API_LOG_PATH@
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
src/main/environment/common_ci.properties(1 hunks)
🔇 Additional comments (1)
src/main/environment/common_ci.properties (1)
139-140: Verify ELK stack integration configuration.
Let's ensure this logging configuration aligns with any existing ELK stack setup in the codebase.
✅ Verification successful
ELK stack configuration is properly aligned with application logging setup
The logging configuration in common_ci.properties using logging.file.name property is consistent with the application's logging setup in application.properties. The main configuration file already uses the same property along with other logging configurations, and there are no direct ELK stack components (logstash, elasticsearch, kibana, filebeat) that require coordination. The parameterized value @env.COMMON_API_LOGGING_FILE_NAME@ in the CI environment properties follows the same pattern as the default logs/common-api.log in the main configuration.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for other ELK-related configurations
echo "Searching for ELK-related configurations..."
rg -l "logstash|elasticsearch|kibana|filebeat|logging" --type properties
# Search for logging configuration in application.properties/yaml files
echo "Searching for existing logging configurations..."
rg "logging\.(file|path|pattern|level|config)" --type properties
Length of output: 415
Script:
#!/bin/bash
# Search for ELK and logging related configurations in all files
echo "Searching for ELK-related configurations..."
rg -l "logstash|elasticsearch|kibana|filebeat"
echo -e "\nSearching for logging file configurations..."
rg "logging\.file\.name|logging\.path|logging\.pattern|logging\.level|logging\.config"
echo -e "\nListing all properties files..."
fd ".*\.properties$"
Length of output: 1528
2 participants
📋 Description
add logging.file.name ci env
JIRA ID:
PSMRI/AMRIT#4
Please provide a summary of the change and the motivation behind it. Include relevant context and details.
✅ Type of Change
ℹ️ Additional Information
Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.
Summary by CodeRabbit
This change enhances the flexibility of logging configurations without affecting existing functionalities.